home *** CD-ROM | disk | FTP | other *** search
/ Pluspack 1 / Caligari Corporation Pluspack1 1998.iso / TSX_SDK / tsxINC / tsxMisc.h < prev    next >
Encoding:
C/C++ Source or Header  |  1998-01-28  |  3.2 KB  |  81 lines
  1. //******************************************************************************
  2. //    File: tsxMisc.h
  3. //  Module: trueSpace eXtensions API
  4. //   Descr: Miscellaneous items
  5. //******************************************************************************
  6.  
  7. #ifndef TSXMISC_H
  8. #define TSXMISC_H
  9.  
  10. #include <windows.h>
  11.  
  12. #include "tsxTypes.h"
  13.  
  14. //------------------------------------------------------------------------------
  15. //    Accessing an installed trueSpace's TSX Version Info
  16. //------------------------------------------------------------------------------
  17.  
  18. // An eXtension may want to confirm that it is compatible with the version of 
  19. // trueSpace it is being installed into (actually, compatible with the TSXAPI),
  20. // by checking the version number of tsxapi.dll .
  21. // 
  22. // Note on TSX API Version numbering scheme:
  23. // Major is the major release version of trueSpace, in hundreds.
  24. // For example,
  25. //   for trueSpace 3, Major = 300; 
  26. //   for trueSpace 3.5 (should there be one) Major = 350.
  27. // Minor is the minor release version of TSX API.
  28. // Negative numbers in the minor refer to pre-release (alpha, beta) versions.
  29. // 
  30. // To check compatibility, 
  31. // if a TSX requires any version on or after [baseMajor, baseMinor],
  32. // check for:  (Major >= baseMajor) && 
  33. //             (Minor >= baseMinor)
  34.  
  35. // Accessing an installed trueSpace's TSX Version Info.  Values placed in
  36. // the arguments.
  37. TSXAPIFN void tsxGetTsVersionNbrs(
  38.     short* pMajor,    // Major version nbr
  39.     short* pMinor    // Minor version nbr
  40.     );
  41.  
  42.  
  43. //------------------------------------------------------------------------------
  44. //    Accessing The primary view-window client area
  45. //------------------------------------------------------------------------------
  46.  
  47. // Returns handle to the main view window.
  48. TSXAPIFN HWND tsxGetMainViewHwnd(void);
  49.  
  50.  
  51. //------------------------------------------------------------------------------
  52. //    Requesting (De)Activation
  53. //------------------------------------------------------------------------------
  54.  
  55. // Requests a left-click action on the extension's button (see tsxOnLeftClick).
  56. // Useful when, e.g.,  an extension wants to leave a panel on the screen even
  57. // when deactivated, and then requests re-activation when a button is clicked
  58. // on this panel. Also useful to deactivate an active extension when user
  59. // exits from extensions parameter panel.
  60. TSXAPIFN tsxERR tsxForceLeftClick(
  61.     int tsxid // extension-id (see tsxGetData)
  62.     );
  63.  
  64.  
  65. //------------------------------------------------------------------------------
  66. //    Heap Memory
  67. //------------------------------------------------------------------------------
  68.  
  69. // Use these memory routines when allocating memory for trueSpace,
  70. // e.g. vertex-array for Polyhedra (tsxPolyh.h).
  71.  
  72. TSXAPIFN void* tsxMalloc( unsigned int size );
  73. TSXAPIFN void* tsxCalloc( unsigned int num, unsigned int size );
  74. // You MUST use the following two functions to reallocate or free
  75. // memory blocks allocated by the above functions.
  76. TSXAPIFN void* tsxRealloc( void* memblock, unsigned int size );
  77. TSXAPIFN void tsxFree( void* memblock );
  78.  
  79. //******************************************************************************
  80. #endif // TSXMISC_H
  81.